---
title: Resonance Audio Unity SDK API Reference
layout: default
exclude_from_menu: true
---
<!DOCTYPE html>
<html devsite>

<head>
  <meta name="project_path" value="/resonance-audio/_project.yaml" />
  <meta name="book_path" value="/resonance-audio/_book.yaml" />
  <meta name="gtm_var" data-key="docType" data-value="reference">
  <title>Overview</title>
  <link href="jsdoc.css" rel="stylesheet">
</head>

<body>
  <div id="jsdoc-body-container">
    <div id="jsdoc-content">
      <div id="jsdoc-content-container">
        <div id="jsdoc-banner" role="banner">
        </div>
        <div id="jsdoc-main" role="main">
          <div class="symbol-index">
            <section>
              <div class="symbol-index-content">
                <h2 id="ResonanceAudio" class="symbol-header">ResonanceAudio</h2>
                <div class="symbol-index-section">
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html" class="!symbol-index-name">ResonanceAudio(context, options)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#ambisonicInput" class="!symbol-index-name">ResonanceAudio#<wbr>ambisonicInput</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#ambisonicOutput" class="!symbol-index-name">ResonanceAudio#<wbr>ambisonicOutput</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#createSource" class="!symbol-index-name">ResonanceAudio#<wbr>createSource(options)</a>
                    </p>
                  </div>
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#output" class="!symbol-index-name">ResonanceAudio#<wbr>output</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#setAmbisonicOrder" class="!symbol-index-name">ResonanceAudio#<wbr>setAmbisonicOrder(ambisonicOrder)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#setListenerFromMatrix" class="!symbol-index-name">ResonanceAudio#<wbr>setListenerFromMatrix(matrix)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#setListenerOrientation" class="!symbol-index-name">ResonanceAudio#<wbr>setListenerOrientation(forwardX, forwardY, forwardZ, upX, upY, upZ)</a>
                    </p>
                  </div>
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#setListenerPosition" class="!symbol-index-name">ResonanceAudio#<wbr>setListenerPosition(x, y, z)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#setRoomProperties" class="!symbol-index-name">ResonanceAudio#<wbr>setRoomProperties(dimensions, materials)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#setSpeedOfSound" class="!symbol-index-name">ResonanceAudio#<wbr>setSpeedOfSound(speedOfSound)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="ResonanceAudio.html#~ResonanceAudioOptions" class="!symbol-index-name">ResonanceAudio~<wbr>ResonanceAudioOptions</a>
                    </p>
                  </div>
                </div>
              </div>
            </section>
            <section>
              <div class="symbol-index-content">
                <h2 id="Source" class="symbol-header">Source</h2>
                <div class="symbol-index-section">
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="Source.html" class="!symbol-index-name">Source(scene, options)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#input" class="!symbol-index-name">Source#<wbr>input</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#setDirectivityPattern" class="!symbol-index-name">Source#<wbr>setDirectivityPattern(alpha, sharpness)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#setFromMatrix" class="!symbol-index-name">Source#<wbr>setFromMatrix(matrix4)</a>
                    </p>
                  </div>
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="Source.html#setGain" class="!symbol-index-name">Source#<wbr>setGain(gain)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#setMaxDistance" class="!symbol-index-name">Source#<wbr>setMaxDistance(maxDistance)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#setMinDistance" class="!symbol-index-name">Source#<wbr>setMinDistance(minDistance)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#setOrientation" class="!symbol-index-name">Source#<wbr>setOrientation(forwardX, forwardY, forwardZ, upX, upY, upZ)</a>
                    </p>
                  </div>
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="Source.html#setPosition" class="!symbol-index-name">Source#<wbr>setPosition(x, y, z)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#setRolloff" class="!symbol-index-name">Source#<wbr>setRolloff(rolloff)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#setSourceWidth" class="!symbol-index-name">Source#<wbr>setSourceWidth(sourceWidth)</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Source.html#~SourceOptions" class="!symbol-index-name">Source~<wbr>SourceOptions</a>
                    </p>
                  </div>
                </div>
              </div>
            </section>
            <section>
              <div class="symbol-index-content">
                <h2 id="Utils" class="symbol-header">Utils</h2>
                <div class="symbol-index-section">
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="Utils.html" class="!symbol-index-name">Utils()</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.ATTENUATION_ROLLOFFS" class="!symbol-index-name">Utils.<wbr>ATTENUATION_ROLLOFFS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_AMBISONIC_ORDER" class="!symbol-index-name">Utils.<wbr>DEFAULT_AMBISONIC_ORDER</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_ATTENUATION_ROLLOFF" class="!symbol-index-name">Utils.<wbr>DEFAULT_ATTENUATION_ROLLOFF</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_AZIMUTH" class="!symbol-index-name">Utils.<wbr>DEFAULT_AZIMUTH</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_DIRECTIVITY_ALPHA" class="!symbol-index-name">Utils.<wbr>DEFAULT_DIRECTIVITY_ALPHA</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_DIRECTIVITY_SHARPNESS" class="!symbol-index-name">Utils.<wbr>DEFAULT_DIRECTIVITY_SHARPNESS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_ELEVATION" class="!symbol-index-name">Utils.<wbr>DEFAULT_ELEVATION</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_FORWARD" class="!symbol-index-name">Utils.<wbr>DEFAULT_FORWARD</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_MAX_DISTANCE" class="!symbol-index-name">Utils.<wbr>DEFAULT_MAX_DISTANCE</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_MIN_DISTANCE" class="!symbol-index-name">Utils.<wbr>DEFAULT_MIN_DISTANCE</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_POSITION" class="!symbol-index-name">Utils.<wbr>DEFAULT_POSITION</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REFLECTION_COEFFICIENTS" class="!symbol-index-name">Utils.<wbr>DEFAULT_REFLECTION_COEFFICIENTS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REFLECTION_CUTOFF_FREQUENCY" class="!symbol-index-name">Utils.<wbr>DEFAULT_REFLECTION_CUTOFF_FREQUENCY</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REFLECTION_MAX_DURATION" class="!symbol-index-name">Utils.<wbr>DEFAULT_REFLECTION_MAX_DURATION</a>
                    </p>
                  </div>
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REFLECTION_MIN_DISTANCE" class="!symbol-index-name">Utils.<wbr>DEFAULT_REFLECTION_MIN_DISTANCE</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REFLECTION_MULTIPLIER" class="!symbol-index-name">Utils.<wbr>DEFAULT_REFLECTION_MULTIPLIER</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REVERB_BANDWIDTH" class="!symbol-index-name">Utils.<wbr>DEFAULT_REVERB_BANDWIDTH</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REVERB_DURATION_MULTIPLIER" class="!symbol-index-name">Utils.<wbr>DEFAULT_REVERB_DURATION_MULTIPLIER</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REVERB_DURATIONS" class="!symbol-index-name">Utils.<wbr>DEFAULT_REVERB_DURATIONS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REVERB_FREQUENCY_BANDS" class="!symbol-index-name">Utils.<wbr>DEFAULT_REVERB_FREQUENCY_BANDS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REVERB_GAIN" class="!symbol-index-name">Utils.<wbr>DEFAULT_REVERB_GAIN</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REVERB_MAX_DURATION" class="!symbol-index-name">Utils.<wbr>DEFAULT_REVERB_MAX_DURATION</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REVERB_PREDELAY" class="!symbol-index-name">Utils.<wbr>DEFAULT_REVERB_PREDELAY</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_REVERB_TAIL_ONSET" class="!symbol-index-name">Utils.<wbr>DEFAULT_REVERB_TAIL_ONSET</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_RIGHT" class="!symbol-index-name">Utils.<wbr>DEFAULT_RIGHT</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_ROOM_DIMENSIONS" class="!symbol-index-name">Utils.<wbr>DEFAULT_ROOM_DIMENSIONS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_ROOM_MATERIALS" class="!symbol-index-name">Utils.<wbr>DEFAULT_ROOM_MATERIALS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_SOURCE_DISTANCE" class="!symbol-index-name">Utils.<wbr>DEFAULT_SOURCE_DISTANCE</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_SOURCE_GAIN" class="!symbol-index-name">Utils.<wbr>DEFAULT_SOURCE_GAIN</a>
                    </p>
                  </div>
                  <div class="symbol-index-column">
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_SOURCE_WIDTH" class="!symbol-index-name">Utils.<wbr>DEFAULT_SOURCE_WIDTH</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_SPEED_OF_SOUND" class="!symbol-index-name">Utils.<wbr>DEFAULT_SPEED_OF_SOUND</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.DEFAULT_UP" class="!symbol-index-name">Utils.<wbr>DEFAULT_UP</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.LISTENER_MAX_OUTSIDE_ROOM_DISTANCE" class="!symbol-index-name">Utils.<wbr>LISTENER_MAX_OUTSIDE_ROOM_DISTANCE</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.NUMBER_REFLECTION_AVERAGING_BANDS" class="!symbol-index-name">Utils.<wbr>NUMBER_REFLECTION_AVERAGING_BANDS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.NUMBER_REVERB_FREQUENCY_BANDS" class="!symbol-index-name">Utils.<wbr>NUMBER_REVERB_FREQUENCY_BANDS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.ROOM_AIR_ABSORPTION_COEFFICIENTS" class="!symbol-index-name">Utils.<wbr>ROOM_AIR_ABSORPTION_COEFFICIENTS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.ROOM_EYRING_CORRECTION_COEFFICIENT" class="!symbol-index-name">Utils.<wbr>ROOM_EYRING_CORRECTION_COEFFICIENT</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.ROOM_MATERIAL_COEFFICIENTS" class="!symbol-index-name">Utils.<wbr>ROOM_MATERIAL_COEFFICIENTS</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.ROOM_MIN_VOLUME" class="!symbol-index-name">Utils.<wbr>ROOM_MIN_VOLUME</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.ROOM_STARTING_AVERAGING_BAND" class="!symbol-index-name">Utils.<wbr>ROOM_STARTING_AVERAGING_BAND</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#.SOURCE_MAX_OUTSIDE_ROOM_DISTANCE" class="!symbol-index-name">Utils.<wbr>SOURCE_MAX_OUTSIDE_ROOM_DISTANCE</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#~RoomDimensions" class="!symbol-index-name">Utils~<wbr>RoomDimensions</a>
                    </p>
                    <p class="symbol-index-name">
                      <a href="Utils.html#~RoomMaterials" class="!symbol-index-name">Utils~<wbr>RoomMaterials</a>
                    </p>
                  </div>
                </div>
              </div>
            </section>
          </div>
        </div>
      </div>
      <nav id="jsdoc-toc-nav" role="navigation"></nav>
    </div>
  </div>
</body>

</html>
